/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hama.bsp.taskallocation;

import org.apache.hama.bsp.TaskInProgress;

/**
 * <code>BSPResource defines a resource entity that would be used as a factor
 * for allocating tasks on groom-servers.
 */
public abstract class BSPResource {

  /**
   * Returns the list of grooms on which the current resource is available or
   * local or is best chosen for the task.
   * 
   * @param tip The <code>TaskInProgress</code> representing the task to
   *          schedule.
   * @return The list of groomserver host names.
   */
  public abstract String[] getGrooms(TaskInProgress tip);

}
